Skip to content

Docs for Extensions: FileProviders and Hosting #4106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Sep 2, 2020
Merged

Docs for Extensions: FileProviders and Hosting #4106

merged 3 commits into from
Sep 2, 2020

Conversation

maryamariyan
Copy link
Contributor

Summary

Docs on:
Microsoft.Extensions.FileProviders.*
Microsoft.Extensions.Hosting.*

@maryamariyan maryamariyan requested a review from a team as a code owner April 14, 2020 00:17
@dotnet-bot dotnet-bot added this to the April 2020 milestone Apr 14, 2020
@carlossanlop carlossanlop added new-content Indicates PRs that contain new articles Release: .NET Core 1.x labels Apr 20, 2020
carlossanlop
carlossanlop suggested changes Apr 20, 2020
View reviewed changes
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @maryamariyan for the PR. I left some suggestions to improve the content and ensuring the elements that were not ported, are also documented in this PR.

I didn't cover all of them. Can you please ensure to apply similar changes to the rest of the elements that are either poorly worded or incomplete?

@BillWagner BillWagner modified the milestones: April 2020, June 2020 Jun 1, 2020
@maryamariyan maryamariyan mentioned this pull request Jun 12, 2020
Closed
11 tasks
@maryamariyan @carlossanlop
Apply suggestions from code review
f836fab 
Applied PR feedback.

Co-authored-by: Carlos Sanchez <[email protected]>
@opbld32
Copy link

opbld32 commented Sep 2, 2020

Docs Build status updates of commit f836fab:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.FileProviders.Composite/CompositeDirectoryContents.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Embedded/EmbeddedResourceFileInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Hosting/BackgroundService.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Options/ConfigurationChangeTokenSource`1.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Internal/PhysicalDirectoryContents.xml ✅Succeeded
xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml ✅Succeeded
xml/Microsoft.Extensions.Hosting.Internal/HostingEnvironment.xml ✅Succeeded

xml/Microsoft.Extensions.FileProviders.Composite/CompositeDirectoryContents.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Embedded/EmbeddedResourceFileInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Hosting/BackgroundService.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Options/ConfigurationChangeTokenSource`1.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@maryamariyan
Copy link
Contributor Author

Thanks @carlossanlop I just merged with latest master to see if warnings go away.

@opbld32
Copy link

opbld32 commented Sep 2, 2020

Docs Build status updates of commit bc4c1c4:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.FileProviders.Composite/CompositeDirectoryContents.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Embedded/EmbeddedResourceFileInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Hosting/BackgroundService.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Options/ConfigurationChangeTokenSource`1.xml ⚠️Warning View Details
xml/Microsoft.Extensions.FileProviders.Internal/PhysicalDirectoryContents.xml ✅Succeeded
xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml ✅Succeeded
xml/Microsoft.Extensions.Hosting.Internal/HostingEnvironment.xml ✅Succeeded

xml/Microsoft.Extensions.FileProviders.Composite/CompositeDirectoryContents.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Embedded/EmbeddedResourceFileInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Hosting/BackgroundService.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Options/ConfigurationChangeTokenSource`1.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@carlossanlop
Copy link
Contributor

The warnings are known issues in the CI, not caused by the changes in this PR.

cc @joelmartinez @TianqiZhang

@carlossanlop carlossanlop merged commit 1dcffe9 into dotnet:master Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gewarren gewarren gewarren left review comments

+1 more reviewer

@carlossanlop carlossanlop carlossanlop approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@maryamariyan maryamariyan

Labels
area-Extensions-FileSystem area-Extensions-Hosting area-Extensions-Options new-content Indicates PRs that contain new articles
Projects
None yet
Milestone
June 2020
Development

Successfully merging this pull request may close these issues.
6 participants
@maryamariyan @opbld32 @carlossanlop @gewarren @BillWagner @dotnet-bot